All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class javax.media.j3d.SceneGraphObject 

java.lang.Object
   |
   +----javax.media.j3d.SceneGraphObject
public abstract class SceneGraphObject
extends Object
SceneGraphObject is a common superclass for all scene graph component objects. This includes Node, Geometry, Appearance, etc.

Constructor Index

o SceneGraphObject()
Constructs a new SceneGraphObject.

Method Index

o clearCapability(int)
Clear the specified capability bit.
o duplicateNode(Node, boolean)
Duplicate any SceneGraphObject specific data here
o duplicateNodeComponent(NodeComponent)
Copies all node information from originalNodeComponent into the current node.
o getCapability(int)
Retrieves the specified capability bit.
o getUserData()
Retrieves the userData field from this scene graph object.
o isCompiled()
Returns a flag indicating whether the node is part of a scene graph that has been compiled.
o isLive()
Returns a flag indicating whether the node is part of a live scene graph.
o setCapability(int)
Sets the specified capability bit.
o setUserData(Object)
Sets the userData field associated with this scene graph object.

Constructors

o SceneGraphObject 
 public SceneGraphObject()
Constructs a new SceneGraphObject.

Methods

o getCapability 
 public final boolean getCapability(int bit)
Retrieves the specified capability bit.

Parameters:
bit - the bit whose value is returned
Returns:
true if the bit is set, false if the bit is clear
o setCapability 
 public final void setCapability(int bit)
Sets the specified capability bit.

Parameters:
bit - the bit to set
Throws: RestrictedAccessException
if this object is part of live or compiled scene graph
o clearCapability 
 public final void clearCapability(int bit)
Clear the specified capability bit.

Parameters:
bit - the bit to clear
Throws: RestrictedAccessException
if this object is part of live or compiled scene graph
o isCompiled 
 public final boolean isCompiled()
Returns a flag indicating whether the node is part of a scene graph that has been compiled. If so, then only those capabilities explicitly allowed by the object's capability bits are allowed.

Returns:
true if node is part of a compiled scene graph, else false
o isLive 
 public final boolean isLive()
Returns a flag indicating whether the node is part of a live scene graph.

Returns:
true if node is part of a live scene graph, else false
o setUserData 
 public void setUserData(Object userData)
Sets the userData field associated with this scene graph object. The userData field is a reference to an arbitrary object and may be used to store any user-specific data associated with this scene graph object---it is not used by the Java 3D API. If this object is cloned, the userData field is copied to the newly cloned object.

Parameters:
userData - a reference to the new userData field
o getUserData 
 public Object getUserData()
Retrieves the userData field from this scene graph object.

Returns:
the current userData field
o duplicateNode 
 public void duplicateNode(Node originalNode,
                           boolean forceDuplicate)
Duplicate any SceneGraphObject specific data here

o duplicateNodeComponent 
 public void duplicateNodeComponent(NodeComponent originalNodeComponent)
Copies all node information from originalNodeComponent into the current node. This method is called from the cloneNodeComponent method which is, in turn, called by the cloneNode method.

See Also:
cloneNodeComponent, cloneNode, cloneTree 
All Packages  Class Hierarchy  This Package  Previous  Next  Index